AbstractDataObject.java

/*******************************************************************************
 * Signavio Core Components
 * Copyright (C) 2012  Signavio GmbH
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
package de.hpi.bpmn2_0.model.data_object;

import java.util.ArrayList;
import java.util.List;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.bind.annotation.XmlTransient;

import de.hpi.bpmn2_0.model.FlowElement;
import de.hpi.bpmn2_0.model.FlowNode;
import de.hpi.bpmn2_0.model.Process;
import de.hpi.bpmn2_0.model.connector.Edge;
import de.hpi.bpmn2_0.transformation.Visitor;

/**
 * The AbstractDataObject abstracts from data related elements, like
 * {@link DataObject}, {@link DataInput}, {@link DataOutput}, {@link DataStore}.
 * 
 * @author Sven Wagner-Boysen
 */
@XmlSeeAlso( { 
	DataObject.class, 
	DataInput.class, 
	DataOutput.class,
	DataStoreReference.class, 
	DataObjectReference.class
})
public abstract class AbstractDataObject extends FlowNode {

	/* Common attributes of data objects */
	protected DataState dataState;
	@XmlAttribute
	protected Boolean isCollection;
    
	public void acceptVisitor(Visitor v){
		v.visitAbstractDataObject(this);
	}

	// @XmlTransient
	// private Boolean isRequiredForStart;
	// @XmlTransient
	// private Boolean isRequiredForCompletion;

	/* Getter & Setter */

	/**
	 * Gets the value of the dataState property.
	 * 
	 * @return possible object is {@link TDataState }
	 * 
	 */
	public DataState getDataState() {
		return dataState;
	}

	/**
	 * Sets the value of the dataState property.
	 * 
	 * @param value
	 *            allowed object is {@link DataState }
	 * 
	 */
	public void setDataState(DataState value) {
		this.dataState = value;
	}

	/**
	 * Gets the value of the isCollection property.
	 * 
	 * @return possible object is {@link Boolean }
	 * 
	 */
	public boolean isIsCollection() {
		if (isCollection == null) {
			return false;
		} else {
			return isCollection;
		}
	}

	/**
	 * Sets the value of the isCollection property.
	 * 
	 * @param value
	 *            allowed object is {@link Boolean }
	 * 
	 */
	public void setIsCollection(Boolean value) {
		this.isCollection = value;
	}

	// /**
	// * @return the isRequiredForStart
	// */
	// public Boolean getIsRequiredForStart() {
	// if(this.isRequiredForStart == null)
	// return false;
	// return isRequiredForStart;
	// }
	//    
	// /**
	// * @param isRequiredForStart the isRequiredForStart to set
	// */
	// public void setIsRequiredForStart(Boolean isRequiredForStart) {
	// this.isRequiredForStart = isRequiredForStart;
	// }
	//    
	// /**
	// * @return the isRequiredForCompletion
	// */
	// public Boolean getIsRequiredForCompletion() {
	// if(this.isRequiredForCompletion == null)
	// return false;
	// return isRequiredForCompletion;
	// }
	//    
	// /**
	// * @param isRequiredForCompletion the isRequiredForCompletion to set
	// */
	// public void setIsRequiredForCompletion(Boolean isRequiredForCompletion) {
	// this.isRequiredForCompletion = isRequiredForCompletion;
	// }

	/* Business logic methodes */

	/**
	 * List of elements already traversed in the graph.
	 */
	@XmlTransient
	private List<FlowElement> processedElements;

	/**
	 * Find an appropriate {@link Process} container for the data object.
	 * 
	 * The algorithm checks the source and target neighborhood nodes of the data
	 * object and the takes the referenced process of one of the neighbors.
	 * 
	 * Navigates into both directions.
	 */
	public void findRelatedProcess() {
		this.processedElements = new ArrayList<FlowElement>();
		Process process = this.findRelatedProcessRecursivly(this);
		if (process != null) {
			this.setProcess(process);
			process.addChild(this);
		}
	}

	/**
	 * Navigates into both directions.
	 * 
	 * @param flowElement
	 *            The {@link FlowElement} to investigate.
	 */
	private Process findRelatedProcessRecursivly(FlowElement flowElement) {
		if (flowElement == null)
			return null;

		/* Check if element is processed already */
		if (this.processedElements.contains(flowElement))
			return null;

		this.processedElements.add(flowElement);

		/*
		 * Check if one of the neighbors is assigned to a Process, otherwise
		 * continue with the after next.
		 */

		for (Edge edge : flowElement.getIncoming()) {
			FlowElement sourceRef = edge.getSourceRef();
			if (sourceRef == null)
				continue;
			Process process = sourceRef.getProcess();
			if (process != null)
				return process;
		}

		for (Edge edge : flowElement.getOutgoing()) {
			FlowElement targetRef = edge.getTargetRef();
			if (targetRef == null)
				continue;
			Process process = targetRef.getProcess();
			if (process != null)
				return process;
		}

		/* Continue with the after next nodes */

		for (Edge edge : flowElement.getIncoming()) {
			Process process = this.findRelatedProcessRecursivly(edge
					.getSourceRef());
			if (process != null)
				return process;
		}

		for (Edge edge : flowElement.getOutgoing()) {
			Process process = this.findRelatedProcessRecursivly(edge
					.getTargetRef());
			if (process != null)
				return process;
		}

		return null;
	}
}